Scenario #2010: Create Self Debitor for Partner with Distinct Contact Data

UseCase Create Self Debitor For Partner => Debitor: D-3101000 - Test AG - main debitor

Properties

Required

Given

name value
partnerPersonTradeName Test AG
billingContactCaption Test AG - billing department
billingContactEmailAddress billing@test-ag.example.org
debitorNumberSuffix 00
billable true
vatId VAT123456
vatCountryCode DE
vatBusiness true
vatReverseCharge false
defaultPrefix tst

partnerPersonUuid

HTTP GET "/api/hs/office/relations?relationType=PARTNER&personData=Test+AG" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }`
=> status: 200 OK 
[ {
  "uuid" : "9c94cdf2-a746-4438-af53-664b87483a65", // partnerRelationUuid
  "anchor" : {
    "uuid" : "c43fc218-ae0e-4d6d-afc9-528d9861c2eb", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "efe3662a-02d9-4fa9-a4f0-29dfd893fd78", // Person: Test AG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Test AG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "7e8be3df-3e34-4548-8b35-d630a30bfd4a", // Contact: Test AG - China
    "caption" : "Test AG - China",
    "postalAddress" : {
      "country" : "China",
      "province" : "Guangdong Province",
      "city" : "Dongguan City",
      "street" : "No.2 Commercial Second Street",
      "district" : "Niushan Wei Wu",
      "department" : "Executive Board",
      "building" : "Thi Chi Koh Building"
    },
    "emailAddresses" : {
      "main" : "norden@test-ag.example.org"
    },
    "phoneNumbers" : {
      "phone" : "++15 999 654321"
    }
  }
} ]

In production, data this query could result in multiple outputs. In that case, you have to find out which is the right one.

BankAccount: Test AG - refund bank account

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }` \
  <<EOF
{
  "holder" : "Test AG - refund bank account",
  "iban" : "DE88100900001234567892",
  "bic" : "BEVODEBB"
}
EOF
=> status: 201 CREATED 7b1c594c-7a5b-4acb-a236-d1cfa4693469

Contact: Test AG - billing department

HTTP POST "/api/hs/office/contacts" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }` \
  <<EOF
{
  "caption" : "Test AG - billing department",
  "emailAddresses" : {
    "main" : "billing@test-ag.example.org"
  }
}
EOF
=> status: 201 CREATED 913a0be6-dea8-4a7c-a6a5-8521327e015a

Create Debitor: D-3101000 - Test AG - main debitor

HTTP POST "/api/hs/office/debitors" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }` \
  <<EOF
{
  "debitorRel" : {
    "anchor.uuid" : "efe3662a-02d9-4fa9-a4f0-29dfd893fd78", // partnerPersonUuid
    "holder.uuid" : "efe3662a-02d9-4fa9-a4f0-29dfd893fd78", // partnerPersonUuid
    "contact.uuid" : "913a0be6-dea8-4a7c-a6a5-8521327e015a" // Contact: Test AG - billing department
  },
  "debitorNumberSuffix" : "00",
  "billable" : true,
  "vatId" : "VAT123456",
  "vatCountryCode" : "DE",
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount.uuid" : "7b1c594c-7a5b-4acb-a236-d1cfa4693469", // BankAccount: Test AG - refund bank account
  "defaultPrefix" : "tst"
}
EOF
=> status: 201 CREATED 10945eec-2c18-4537-9b5a-eb0de774885d

generated on 2026-08-10 04:42:24 for branch HEAD